@rimbu/collection-types

@rimbu/collection-types

This package contains the type definitions for the basic generic Rimbu collections.

For complete documentation please visit the Immutable Collections page Rimbu Docs.

Or Try Out Rimbu in CodeSandBox.

Installation

All types are exported through @rimbu/core. It is recommended to use that package. The types in this package are mostly abstract and have no actual implementation.

To install this package only:

Yarn/NPM

yarn add @rimbu/collection-types

or

npm i @rimbu/collection-types

Deno

Create a file called rimbu.ts and add the following:

export * from 'https://deno.land/x/rimbu/collection-types/mod.ts';

Or using a pinned version (x.y.z):

export * from 'https://deno.land/x/rimbu/collection-types@x.y.z/mod.ts';

Then import what you need from rimbu.ts:

import { VariantMap } from './rimbu.ts';

Because Rimbu uses complex types, it's recommended to use the --no-check flag (your editor should already have checked your code) and to specify a tsconfig.json file with the settings described below.

Running your script then becomes:

deno run --no-check --config tsconfig.json <your-script>.ts

Recommended tsconfig.json settings

Rimbu uses advanced and recursive typing, potentially making the TypeScript compiler quite slow in some cases, or causing infinite recursion. It is recommended to set the following values in the tsconfig.json file of your project:

{
  "compilerOptions": {
    "skipLibCheck": true,
    "noStrictGenericChecks": true
  }
}

Author

Arvid Nicolaas

Contributing

Feel very welcome to contribute to further improve Rimbu. Please read our Contributing guide.

Contributors

Made with contributors-img.

License

Licensed under the MIT License, Copyright © 2020-present Arvid Nicolaas.

See LICENSE for more information.